monitoring-tools-ux

1.0.x
(0 reviews)

Retrieve Incident Details by Incident number

/{businessId}/troubleTicket/{id}

[GET]

This usecase is to retrieve the incident details from Salesforce by Zabbix.

URL
https://[localhost]:[port]/monitoring-tools-ux/v1/{businessId}/troubleTicket/{id}
Params
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code identifying the business unit. For Zabbix Integration: CW, BO, SA, SE, SX, MF, CO, HN, CR, DO, SV, GTY
idstringSalesforce Object Id of the Incident (from the Create incident response field - externalId)Y
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel.Y
client_secretstringPassword associated with the client_id.Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.
Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request syntax: correlationId: uuid:cwc--, example: correlationId: f058ebd6-02f7-4d3f-942e-904344e8cde5:cwc--qacarepc		Y
Salesforce tenants
SF Environment to ConnectSF Instance
QAcwc--qacarepc
UATcwc--uatsfdc
Productioncwc--prod

Query Params

NameTyperequiredDescription
channel.namestringYChannel Name Default:Zabbix
cURL request
curl --location '
https:/[localhost]:[port]/test/monitoring-tools-ux/v1/CO/troubleTicket/INC-000000026?channel.name=Zabbix'
\
--header 'X-Correlation-ID: 123345432:cwc--qacarepc' \
--header 'client_id: xxxxxx' \
--header 'client_secret: xxxxxx' \
Response
{
    "id": "INC-000000062",
    "creationDate": "2020-01-08T12:06:38.230Z",
    "externalId": "0124X000001hi9aQAA",
    "status": "closed",
    "relatedParty": [
        {
            "id": "0010500000eCMAmAAO",
            "name": "0030500000Z9BiiAAF",
            "role": "User"
        }
    ],
    "relatedEntity": [
        {
            "id": "0tA8B0000004NgGUAU",
            "role": "MonitoringTicket",
            "name":"AssetId",
            "@referredType": "TroubleTicket"
        },
        {
            "id": "0y4B0000007NgHGDGH",
            "role": "MonitoringTicket",
            "name":"AssetId",
            "@referredType": "TroubleTicket"
        }
    ],
    "troubleTicketCharacteristic": [
        {
            "name": "AffectedDate",
            "value": "20-04-2024"
        },
        {
            "name": "FailureLocation",
            "value": "Datacenter"
        },
        {
            "name": "OwnerId",
            "value": "0ny79000000KyqlAAC"
        },
        {
            "name": "DownTime",
            "value": "23-04-2024"
        },
        {
            "name": "DownTimeCode",
            "value": "23-04-2024"
        },
        {
            "name": "ResolvedById",
            "value": "0ny68000000KyqlGGG"
        },
        {
            "name": "isSecurityIncident",
            "value": false
        },
        {
            "name": "isMajorIncident",
            "value": false
        },
        {
            "name": "isEscalated",
            "value": false
        }
    ],
    "troubleTicketRelationship": [
        {
            "id": "500do000000IJDtAAO", // Case number "01009126" mapping is replaced with case id,
            "name": "Case",
            "@type": "TroubleTicketRelationship"
        }
    ],
    "@type": "TroubleTicket"
}

Reviews